home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2001 May / SGI IRIX Base Documentation 2001 May.iso / usr / share / catman / p_man / cat3 / X11 / XSetTextProperty.z / XSetTextProperty
Encoding:
Text File  |  1998-10-30  |  6.3 KB  |  133 lines
  1.  
  2.  
  3.  
  4.      XXXXSSSSeeeettttTTTTeeeexxxxttttPPPPrrrrooooppppeeeerrrrttttyyyy((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....3333))))XXXXSSSSeeeettttTTTTeeeexxxxttttPPPPrrrrooooppppeeeerrrrttttyyyy((((3333XXXX11111111))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XSetTextProperty, XGetTextProperty - set and read text
  10.           properties
  11.  
  12.      SSSSYYYYNNNNTTTTAAAAXXXX
  13.           void XSetTextProperty(_d_i_s_p_l_a_y, _w, _t_e_x_t__p_r_o_p, _p_r_o_p_e_r_t_y)
  14.                 Display *_d_i_s_p_l_a_y;
  15.                 Window _w;
  16.                 XTextProperty *_t_e_x_t__p_r_o_p;
  17.                 Atom _p_r_o_p_e_r_t_y;
  18.  
  19.           Status XGetTextProperty(_d_i_s_p_l_a_y, _w, _t_e_x_t__p_r_o_p__r_e_t_u_r_n,
  20.           _p_r_o_p_e_r_t_y)
  21.                  Display *_d_i_s_p_l_a_y;
  22.                  Window _w;
  23.                  XTextProperty *_t_e_x_t__p_r_o_p__r_e_t_u_r_n;
  24.                  Atom _p_r_o_p_e_r_t_y;
  25.  
  26.      AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  27.           _d_i_s_p_l_a_y   Specifies the connection to the X server.
  28.  
  29.           _p_r_o_p_e_r_t_y  Specifies the property name.
  30.  
  31.           _t_e_x_t__p_r_o_p Specifies the _X_T_e_x_t_P_r_o_p_e_r_t_y structure to be used.
  32.  
  33.           _t_e_x_t__p_r_o_p__r_e_t_u_r_n
  34.                     Returns the _X_T_e_x_t_P_r_o_p_e_r_t_y structure.
  35.  
  36.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  37.           The _X_S_e_t_T_e_x_t_P_r_o_p_e_r_t_y function replaces the existing
  38.           specified property for the named window with the data, type,
  39.           format, and number of items determined by the value field,
  40.           the encoding field, the format field, and the nitems field,
  41.           respectively, of the specified _X_T_e_x_t_P_r_o_p_e_r_t_y structure.  If
  42.           the property does not already exist, _X_S_e_t_T_e_x_t_P_r_o_p_e_r_t_y sets
  43.           it for the specified window.
  44.  
  45.           _X_S_e_t_T_e_x_t_P_r_o_p_e_r_t_y can generate _B_a_d_A_l_l_o_c, _B_a_d_A_t_o_m, _B_a_d_V_a_l_u_e,
  46.           and _B_a_d_W_i_n_d_o_w errors.
  47.  
  48.           The _X_G_e_t_T_e_x_t_P_r_o_p_e_r_t_y function reads the specified property
  49.           from the window and stores the data in the returned
  50.           _X_T_e_x_t_P_r_o_p_e_r_t_y structure.  It stores the data in the value
  51.           field, the type of the data in the encoding field, the
  52.           format of the data in the format field, and the number of
  53.           items of data in the nitems field.  An extra byte containing
  54.           null (which is not included in the nitems member) is stored
  55.           at the end of the value field of text_prop_return.  The
  56.           particular interpretation of the property's encoding and
  57.           data as text is left to the calling application.  If the
  58.           specified property does not exist on the window,
  59.           _X_G_e_t_T_e_x_t_P_r_o_p_e_r_t_y sets the value field to NULL, the encoding
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 4/30/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXSSSSeeeettttTTTTeeeexxxxttttPPPPrrrrooooppppeeeerrrrttttyyyy((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....3333))))XXXXSSSSeeeettttTTTTeeeexxxxttttPPPPrrrrooooppppeeeerrrrttttyyyy((((3333XXXX11111111))))
  71.  
  72.  
  73.  
  74.           field to _N_o_n_e, the format field to zero, and the nitems
  75.           field to zero.
  76.  
  77.           If it was able to read and store the data in the
  78.           _X_T_e_x_t_P_r_o_p_e_r_t_y structure, _X_G_e_t_T_e_x_t_P_r_o_p_e_r_t_y returns a nonzero
  79.           status; otherwise, it returns a zero status.
  80.  
  81.           _X_G_e_t_T_e_x_t_P_r_o_p_e_r_t_y can generate _B_a_d_A_t_o_m and _B_a_d_W_i_n_d_o_w errors.
  82.  
  83.      PPPPRRRROOOOPPPPEEEERRRRTTTTIIIIEEEESSSS
  84.           WM_CLIENT_MACHINE
  85.                     The string name of the machine on which the client
  86.                     application is running.
  87.  
  88.           WM_COMMAND
  89.                     The command and arguments, null-separated, used to
  90.                     invoke the application.
  91.  
  92.           WM_ICON_NAME
  93.                     The name to be used in an icon.
  94.  
  95.           WM_NAME   The name of the application.
  96.  
  97.      DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  98.           _B_a_d_A_l_l_o_c  The server failed to allocate the requested
  99.                     resource or server memory.
  100.  
  101.           _B_a_d_A_t_o_m   A value for an Atom argument does not name a
  102.                     defined Atom.
  103.  
  104.           _B_a_d_V_a_l_u_e  Some numeric value falls outside the range of
  105.                     values accepted by the request.  Unless a specific
  106.                     range is specified for an argument, the full range
  107.                     defined by the argument's type is accepted.  Any
  108.                     argument defined as a set of alternatives can
  109.                     generate this error.
  110.  
  111.           _B_a_d_W_i_n_d_o_w A value for a Window argument does not name a
  112.                     defined Window.
  113.  
  114.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  115.           XAllocClassHint(3X11), XAllocIconSize(3X11),
  116.           XAllocSizeHints(3X11), XAllocWMHints(3X11),
  117.           XSetCommand(3X11), XSetTransientForHint(3X11),
  118.           XSetWMClientMachine(3X11), XSetWMColormapWindows(3X11),
  119.           XSetWMIconName(3X11), XSetWMName(3X11),
  120.           XSetWMProperties(3X11), XSetWMProtocols(3X11),
  121.           XStringListToTextProperty(3X11)
  122.           _X_l_i_b - _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 4/30/98)
  130.  
  131.  
  132.  
  133.